Platform Explorer / Nuxeo Platform 6.0

Component org.nuxeo.ecm.platform.rendition.service.RenditionService

In bundle org.nuxeo.ecm.platform.rendition.core

Documentation

The Rendition Service handles the registered rendition definitions and the rendering of a document based on a rendition definition. It provides an extension point to register rendition definitions.

Implementation

Class: org.nuxeo.ecm.platform.rendition.service.RenditionServiceImpl

Services

Extension Points

XML Source

<?xml version="1.0"?>
<component name="org.nuxeo.ecm.platform.rendition.service.RenditionService">

  <documentation>
    The Rendition Service handles the registered rendition definitions and
    the rendering of a document based on a rendition definition.
    It provides an extension point to register rendition definitions.

    @author Thomas Roger (troger@nuxeo.com)
  </documentation>

  <implementation
    class="org.nuxeo.ecm.platform.rendition.service.RenditionServiceImpl" />

  <service>
    <provide interface="org.nuxeo.ecm.platform.rendition.service.RenditionService" />
  </service>

  <extension-point name="renditionDefinitions">
    <documentation>
      Extension point to register rendition definitions.
      For instance, here is one defining a PDF rendition.
      <code>
        <renditionDefinition name="pdf" enable="true">
          <label>label.rendition.pdf</label>
          <operationChain>blobToPDF</operationChain>
        </renditionDefinition>
      </code>
      
      Since 6.0 : 
      <ul>
         <li> a new allowEmptyBlob tag has been added. Setting it's value to true will allow the rendition to be available even if the target Document does not contains a Blob.</li>
         <li> a new visible attribute has been added. Setting it's value to false will allow the rendition to be hidden from the UI services.</li>
      </ul>
            
    </documentation>
    <object class="org.nuxeo.ecm.platform.rendition.service.RenditionDefinition" />
  </extension-point>

</component>